home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 22 / Cream of the Crop 22.iso / bbs / g5109b.zip / G5.ZIP / G5_STRUC.ZIP / README!.TXT < prev   
Text File  |  1996-11-27  |  8KB  |  143 lines
  1.  
  2.                               ──══ Galaxy 5 ══──
  3.                       Copyright (c) 1996 Thomas J. Smith
  4.  
  5.  ────────────────────────────────────────────────────────────────────────────
  6.   DROPFILE.*, NODE*.DAT, DORINFO*.DEF, & DATA*.NFO are all created in the
  7.   TEMP subdirectory. So if your Galaxy 5 directory was C:\DOORS\G5, then the
  8.   dropfile directory would be C:\DOORS\G5\TEMP.
  9.  ────────────────────────────────────────────────────────────────────────────
  10.                                      -=≡=-
  11.  ────────────────────────────────────────────────────────────────────────────
  12.        Here is a list of files that should be included with G5_STRUC.ZIP
  13.  ────────────────────────────────────────────────────────────────────────────
  14.   G5_STRUC.PAS - Data file structures.
  15.   DROPFILE.1   - Format of the DROPFILE.* drop file created for Xport use.
  16.   NODE1.DAT    - Format of the NODE*.DAT drop file created for Xport use.
  17.   DORINFO1.DEF - Format of the DORINFO*.DEF drop file created for Xport use.
  18.   DATA1.NFO    - Format of the DATA*.NFO drop file created for authors who
  19.                  do not program in Turbo Pascal.
  20.   MAIL.TXT     - Format of mail files.
  21.   G5_CODES.TXT - List of all color codes, and other codes used by G5.
  22.   README!.TXT  - This text file.
  23.  ────────────────────────────────────────────────────────────────────────────
  24.   These four files,
  25.                     DROPFILE.*
  26.                     NODE*.DAT
  27.                     DORINFO*.DEF
  28.                     DATA*.NFO
  29.  
  30.   Never exist at any given time. They are created in the TEMP subdirectory
  31.   by Galaxy 5 when a caller uses an Xport, or when one of the automatic
  32.   batch files are ran (if they exist). They can be used by 3rd party
  33.   programmers to create their own add ons for Galaxy 5. Like IGM's in the
  34.   popular door game, LORD by Seth Able Robinson. UrDoor programmers may
  35.   find it easy to create an Xport for Galaxy 5, since the first 7 lines of
  36.   the DROPFILE.* file, are written in the format required by the UrDoor
  37.   unit! ;> DDplus door programmers may also find it easy to use the
  38.   NODE*.DAT file, since its entire format is written to work with the
  39.   DDplus door driver (it is a control file that DDplus requires). And
  40.   other door programmers can use DORINFO*.DEF if the door writing kit you
  41.   are using can read these types of BBS drop files, if not, then you can
  42.   set up your Xport to read from one or more of these three drop files.
  43.   You can read from any of these files, or all of em if you need to. Do
  44.   whatever you have to to get a working Xport created!  <G>
  45.  ────────────────────────────────────────────────────────────────────────────
  46.  
  47.  
  48.                               THE DATA*.NFO FILE
  49.  ────────────────────────────────────────────────────────────────────────────
  50.   The DATA*.NFO file does NOT contain information that your Xport may need
  51.   to actually "operate." This file contains all of the info of the players
  52.   record who is using the Xport.
  53.  ────────────────────────────────────────────────────────────────────────────
  54.   If you write doors in a language other than Turbo Pascal, and wish to
  55.   write an Xport for Galaxy 5, I have now made it easy for you to do! ;>
  56.   There are basically two things you will need to do in order to do this...
  57.  
  58.           1) Determine which drop file(s) you will use to gather door
  59.              information such as COM port, baud rate, etc. etc.
  60.  
  61.           2) Setup a routine in your Xport that reads the players info from
  62.              the DATA*.NFO file, and a routine that writes any changes that
  63.              your Xport makes to the players info, back to the DATA*.NFO
  64.              file, so that G5 can make the appropriate changes if any.
  65.  ────────────────────────────────────────────────────────────────────────────
  66.  
  67.   How it works
  68.  --------------
  69.   When running an Xport, Galaxy 5 creates the 4 drop files described above.
  70.   After gathering the COM port info, and/or whatever other info you may
  71.   need to operate your Xport from one or more of the 3 drop files created
  72.   for that purpose, you need to read in the player info from the DATA*.NFO
  73.   file (where * is the node number the player is on), and save the values
  74.   to your own variables. After your Xport is finished, just before exiting
  75.   back to the game, your Xport must rewrite the DATA*.NFO file, using the
  76.   new values (if any). When Galaxy 5 reloads, it reads the DATA*.NFO file,
  77.   and saves all of the values therein to the players record. You MUST change
  78.   line 1 in this file to MODIFIED=YES if you want Galaxy 5 to record the
  79.   changes in this file to the players record!
  80.  
  81.   Rules of thumb
  82.  ----------------
  83.   1) You MUST write on the very first line of the DATA*.NFO file,
  84.      MODIFIED=YES in order for Galaxy 5 to accept the changes. Otherwise,
  85.      the changes made to the DATA*.NFO file will be ignored.
  86.  
  87.   2) You MUST write ALL of the info back to the DATA*.NFO file! Even if you
  88.      only made changes to a few values! When Galaxy 5 reads in the
  89.      DATA*.NFO file, if it finds ANY problems in the format (strings where
  90.      numerals were expected, etc.), then it will completely IGNORE the info
  91.      contained in the DATA*.NFO file.
  92.  
  93.   3) If no changes were made to any of the values, then you can just have
  94.      your Xport either erase the DATA*.NFO file, or leave the original one
  95.      that G5 created upon running your Xport, and no changes will be made
  96.      to the players record. If the DATA*.NFO file is not found when G5
  97.      reloads, then it will act as if nothing has changed.
  98.  
  99.   4) BE CAREFUL! Inserting the wrong value in an improper line number of
  100.      the DATA*.NFO file when your Xport finishes, can have unpredicted
  101.      results (if G5 accepts the mistake for some reason). For example,
  102.      putting the users amount of krills in the bank on the line that is
  103.      supposed to contain the players fights left for the day...be careful
  104.      not to do things like this. Try to make sure you follow the exact
  105.      format shown in the example DATA1.NFO file when writing your values
  106.      back to the file.
  107.  
  108.   5) Do NOT use commas in your large amounts! If you do, then ALL of the
  109.      info in the DATA*.NFO file will be ignored. For example, if the player
  110.      leaves your Xport with 412,520 krills, write it to the DATA*.NFO file
  111.      as 412520, not 412,520.
  112.  ────────────────────────────────────────────────────────────────────────────
  113.  
  114.  
  115.                            ALLOWING OVERNIGHT STAYS
  116.      ────────────────────────────────────────────────────────────────────
  117.       If you wish to allow players to stay the night in your Xport, then
  118.       here is what you need to do...
  119.  
  120.       1) Upon exiting your Xport, first create a file named EXITGAME.#
  121.          where # is replaced by the node number. This file does not have
  122.          to contain anything special, in fact, it can even be a 0 byte
  123.          file. Simply put, if it exists, then the game will exit upon
  124.          returning from your Xport.
  125.  
  126.       2) Create a record in the XPORTINF.DAT file, located (or will be)
  127.          in the DATA subdirectory. The format of this file is given in
  128.          the G5_STRUC.PAS file located inside the G5_STRUC.ZIP file. If
  129.          this file does not yet exist, then you must create it. If it
  130.          does exist, then add a record to it for the current player.
  131.  
  132.       3) Thats it! The game will exit when your Xport is finished, and
  133.          the next time the caller plays G5, he/she will be taken directly
  134.          to your Xport.
  135.  
  136.       I know this is not the best way, but I did not want to change the
  137.       structure of the PLAYERS.DAT file (this would have been easiest).
  138.       If I did that, then all Xports and utilities that use the
  139.       PLAYERS.DAT file, would also have to be updated, and SysOps would
  140.       not be able to use them until they were updated.
  141.      ────────────────────────────────────────────────────────────────────
  142.  
  143.